home *** CD-ROM | disk | FTP | other *** search
/ Technotools / Technotools (Chestnut CD-ROM)(1993).ISO / batch / bbb_v21 / bbb.doc < prev    next >
Text File  |  1991-11-25  |  7KB  |  201 lines
  1.  
  2.                           -- BBB v2.1 --
  3.                      Brent's Batch Beautifier
  4.                       (c) 1991 Brent Ashley
  5.  
  6. With Brent's Batch Beautifier you can bemuse your buddies or 
  7. boggle your beau or boss with beautiful batches that simply 
  8. bulge with brilliance.  In conjunction with Brent's Environment 
  9. Tools (BET), you can create some REALLY powerful batches that 
  10. usually wouldn't be possible without a high-level compiled 
  11. language.  
  12.  
  13. Full source is now included for those who are interested.  
  14. Microsoft QuickBASIC v 4.0 or later and Crescent Software's
  15. PDQ version 2.16 or later are required to recompile the source.
  16.  
  17. BBB sends screen control codes to your ANSI-compatible console 
  18. driver, thereby simplifying the process of making your batch files 
  19. attractive and colorful.  The commands supported by BBB allow:
  20.  
  21. o  Testing for ANSI-compatible console driver
  22. o  Cursor position saving, restoring and setting
  23. o  Display color and attribute setting
  24. o  Screen mode changes
  25. o  Box drawing with choice of fill and border
  26. o  Text display and string repeating
  27. o  Speaker beep and alarm
  28. o  Time, date, day of week
  29. o  Gas gauge meter
  30. o  Timed pause
  31. o  Keyboard input, flush, and stuffing
  32. o  DOS Environment editing
  33. o  Warm and cold reboot
  34. o  PrintScreen enable/disable
  35.  
  36. Most commands have both long and short forms, and commands can be 
  37. stacked in either or both forms to the end of the command line 
  38. (128 characters).  Each command is listed below with its short 
  39. form and syntax.  BBB examples can be found in DEMO.BAT.
  40.  
  41. NOTE: Remember to have an ANSI-compatible screen driver loaded in 
  42.       your CONFIG.SYS file!
  43.  
  44. Display Attributes:
  45. -------------------
  46. BOLD/!
  47. - Sets hi-intensity ON
  48.  
  49. UNDERLINE/_
  50. - Sets underline ON (monochrome adapter only)
  51.  
  52. BLINK/;
  53. - Sets flashing characters ON
  54.  
  55. REVERSE/*
  56. - Sets color to black on white
  57.  
  58. RESET/^
  59. - Resets all display attributes and sets color to white on black
  60.  
  61. COLOR/C Fore Back
  62. - Sets color to Fore on Back
  63. - choices for Fore and Back are:
  64.   BLACK/0 RED/1 GREEN/2 YELLOW/3 BLUE/4 MAGENTA/5 CYAN/6 WHITE/7
  65.  
  66. Cursor and Screen Control:
  67. --------------------------
  68. CLEAR/#
  69. - clears screen to current color and positions cursor at top left
  70.  
  71. CLREOL/)
  72. - clears to current color from cursor position to end of line
  73. - cursor remains at current position
  74.  
  75. SAVE/{
  76. - saves current cursor position
  77.  
  78. RESTORE/}
  79. - returns cursor to saved position
  80.  
  81. LOCATE/@ Row Col
  82. - Places cursor at position specified by Row and Col
  83.  
  84. MODE/M Mode
  85. - Changes screen mode (color/mono, 40/80 columns)
  86. - choices for Mode are: M40 M80 C40 C80
  87.  
  88. Text, String Output:
  89. --------------------
  90. SAY/? all text up to tilde~
  91. - displays text from first non-space character to tilde(~) at 
  92.   current cursor position and updates cursor position
  93.  
  94. STRING/$ string up to tilde~ Repeats
  95. - displays string number of times specified by Repeats
  96.  
  97. BOX/B Top Lft Bot Rgt Fill Border [CharNum]
  98. - saves cursor position, draws box from Top Lft to Bot Rgt, filled 
  99.   or empty, with specified border and returns cursor to original 
  100.   position.
  101. - Choices for Fill are: FILL/F EMPTY/E
  102. - Choices for Border are: SINGLE/S DOUBLE/D BLOCK/B or CHAR/C nnn
  103. - you must use a 3-digit number for nnn
  104.  
  105. GAUGE/G Percent
  106. - displays 50-char shaded gas gauge bar filled to Percent level
  107.  
  108. ENTER/E
  109. - outputs a Carriage Return to the console (all other string commands
  110.   leave cursor at end of string without advancing to the next line)
  111.  
  112. TIME/T
  113. - displays time on format hh:mm:ss
  114.  
  115. DATE/D
  116. - displays date in format mm-dd-yy
  117.  
  118. Interactive features and Misc:
  119. ------------------------------
  120. ANSITEST
  121. - reports if ANSI.SYS is loaded.  The ANSI-detect routine is run 
  122.   whenever BBB is invoked and returns DOS errorlevel 255 if ANSI is
  123.   NOT available.  This command simply displays verification of ANSI 
  124.   availability.  There is no short form for the ANSITEST command.
  125. - execution ends at ANSITEST command - remaining command line ignored.
  126.  
  127. BOOT [COLD]
  128. - reboots machine.  Warm boot unless COLD is specified.
  129. - there is no short form for the BOOT command or its COLD parameter.
  130. - execution ends at BOOT command - remaining command line ignored.
  131.  
  132. PAUSE/P Seconds
  133. - if Seconds=0 waits until any key is pressed
  134.  
  135. FLUSH/F
  136. - flushes keyboard buffer of pending keystrokes
  137.  
  138. STUFF text up tilde~ (&=Return)
  139. - stuffs the specified text into the keyboard buffer to be retrieved  
  140.   by the next program (or DOS) that asks for input.  Any ampersand 
  141.   (&) characters in the string are replaced with carriage returns 
  142.   before stuffing.
  143.  
  144. BEEP/+
  145. - sounds speaker
  146.  
  147. ALARM/A Repeats
  148. - sounds three-note alarm number of times specified by Repeats
  149. - if Repeats=0 then sounds alarm until key is pressed
  150.  
  151. WEEKDAY/W
  152. - returns day of week as ERRORLEVEL (great for backup batches!)
  153. - 0 = Sunday ... 6 = Saturday
  154. - execution ends at WEEKDAY command - remaining command line ignored
  155.  
  156. INPUT/I EnvironmentVariableName
  157. - waits for user to input a string terminated by [ENTER] and assigns
  158.   string to the DOS environment variable specified
  159. - *NOTE*: if not enough environment space exists to allocate the 
  160.   variable, the variable will not be created and the error message
  161.   "BBB - not enough DOS environment space" will be displayed on
  162.   screen line 25.
  163.  
  164. QUERY/Q ValidString
  165. - waits for user to press a key in ValidString and returns DOS
  166.   ERRORLEVEL==position of key in string
  167. - beeps if invalid key pressed
  168. - execution ends at QUERY command - remaining command line ignored
  169.  
  170. UPCASE/U EnvironmentVariableName
  171. - forces environment variable to uppercase for easier comparisons
  172.  
  173. PRTSCR ON/OFF
  174. -  Enables or disables PrintScreen key.
  175.  
  176.                       -- Revision History --
  177.  
  178. 1.0 - first release - 5 Aug 1991
  179. 1.1 - add INPUT, ALARM, FLUSH, WEEKDAY, UPCASE 
  180. 1.2 - add ANSITEST and test for ANSI.SYS in init code, BOOT
  181. 2.0 - add cold boot, STUFF, PRTSCR 
  182.     - release with Brent's Environment Tools v1.0
  183. 2.1 - compiled with PDQ v3.0
  184.     - add BOX CHAR nnn
  185.     - release source free with package
  186.  
  187.                             -- Note --
  188.  
  189. BBB and BET are distributed as Freeware.  This means that while anyone can 
  190. use them at no cost in a personal, business, or government environment, I
  191. retain the copyright.  
  192.  
  193. Both programs were written in Microsoft QuickBASIC and linked with 
  194. Crescent Software's PDQ link library. 
  195.  
  196. Brent Ashley
  197. 8 Darnock Court
  198. Brampton, Ontario
  199. L6Z 2X3
  200. CANADA
  201.